Skip to content

[#345] Update model outputs documentation#347

Draft
Rahmankhan3 wants to merge 1 commit into
PecanProject:masterfrom
Rahmankhan3:fix-model-outputs-docs
Draft

[#345] Update model outputs documentation#347
Rahmankhan3 wants to merge 1 commit into
PecanProject:masterfrom
Rahmankhan3:fix-model-outputs-docs

Conversation

@Rahmankhan3

@Rahmankhan3 Rahmankhan3 commented Jun 11, 2026

Copy link
Copy Markdown

Summary

  • What: Updated docs/user-guide/model-outputs.md to document missing output columns and correct column numbering.
  • Motivation: The documentation did not fully match the current sipnet.out output header. In particular, plantStorageN and nppStorage were missing from the output table, and the column numbering was not consecutive.

How was this change tested?

  • Compared the documented output table against the current output header generated by the implementation (outputHeader).
  • Verified that the documented column order matches the current output format.
  • Confirmed that numbering is consecutive after adding the missing output columns.

Reproduction steps

  1. Open docs/user-guide/model-outputs.md.
  2. Review the "Model Outputs" table.
  3. Compare the documented outputs with the current sipnet.out header.
  4. Verify that plantStorageN and nppStorage are documented and that column numbering is consecutive.

Related issues

Checklist

  • Related issues are listed above.
  • PR title has the issue number in it.
  • Tests added/updated for new features (not applicable)
  • Documentation updated.
  • docs/CHANGELOG.md updated with noteworthy changes
  • Code formatted with clang-format (not applicable)

@Alomir Alomir left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm marking this as "request changes" for now, as we have pending discussion points in the related ticket.

@Alomir

Alomir commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Also, converting to draft until we've decided on a course of action.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make sure that documentation of sipnet.out header reflects implementation

2 participants